<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.6"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Percepio Trace Recorder: include/trcMultiCoreEventBuffer.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Percepio Trace Recorder<span id="projectnumber">&#160;v4.10.3</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.6 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('trcMultiCoreEventBuffer_8h_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
  <div class="headertitle"><div class="title">trcMultiCoreEventBuffer.h</div></div>
</div><!--header-->
<div class="contents">
<a href="trcMultiCoreEventBuffer_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/*</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment">* Percepio Trace Recorder for Tracealyzer v4.10.3</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment">* Copyright 2023 Percepio AB</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment">* www.percepio.com</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment">*</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment">* SPDX-License-Identifier: Apache-2.0</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment">*/</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span> </div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="preprocessor">#ifndef TRC_MULTI_CORE_EVENT_BUFFER_H</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="preprocessor">#define TRC_MULTI_CORE_EVENT_BUFFER_H</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="preprocessor">#if (TRC_USE_TRACEALYZER_RECORDER == 1) &amp;&amp; (TRC_CFG_RECORDER_MODE == TRC_RECORDER_MODE_STREAMING)</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span><span class="preprocessor">#include &lt;trcTypes.h&gt;</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span> </div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="structTraceMultiCoreEventBuffer.html">   35</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structTraceMultiCoreEventBuffer.html">TraceMultiCoreEventBuffer</a>    <span class="comment">/* Aligned */</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span>{</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span>    <a class="code hl_struct" href="structTraceEventBuffer.html">TraceEventBuffer_t</a> *xEventBuffer[TRC_CFG_CORE_COUNT]; </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="group__trace__multi__core__event__buffer__apis.html#gaf23fd9ffec1156975504070f60c3e55f">   38</a></span>} <a class="code hl_typedef" href="group__trace__multi__core__event__buffer__apis.html#gaf23fd9ffec1156975504070f60c3e55f">TraceMultiCoreEventBuffer_t</a>;</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span> </div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span>traceResult xTraceMultiCoreEventBufferInitialize(<a class="code hl_struct" href="structTraceMultiCoreEventBuffer.html">TraceMultiCoreEventBuffer_t</a>* <span class="keyword">const</span> pxTraceMultiCoreEventBuffer, uint32_t uiOptions,</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span>    uint8_t* puiBuffer, uint32_t uiSize);</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span> </div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span> </div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span> </div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span><span class="preprocessor">#if ((TRC_CFG_USE_TRACE_ASSERT) == 1)</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span>traceResult <a class="code hl_define" href="group__trace__multi__core__event__buffer__apis.html#gadb329fba83672d7274b724cc4222206a">xTraceMultiCoreEventBufferAlloc</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structTraceMultiCoreEventBuffer.html">TraceMultiCoreEventBuffer_t</a> * <span class="keyword">const</span> pxTraceMultiCoreEventBuffer, uint32_t uiSize, <span class="keywordtype">void</span>** ppvData);</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span> </div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span>traceResult <a class="code hl_define" href="group__trace__multi__core__event__buffer__apis.html#gaf5ee31252fbbf0c4fcd9574d2de2eaaf">xTraceMultiCoreEventBufferAllocCommit</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structTraceMultiCoreEventBuffer.html">TraceMultiCoreEventBuffer_t</a> * <span class="keyword">const</span> pxTraceMultiCoreEventBuffer, <span class="keywordtype">void</span> *pvData, uint32_t uiSize, int32_t *piBytesWritten);</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span> </div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span>traceResult <a class="code hl_define" href="group__trace__multi__core__event__buffer__apis.html#gabd1c68a3c443385a498221cd82ec20a5">xTraceMultiCoreEventBufferPush</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structTraceMultiCoreEventBuffer.html">TraceMultiCoreEventBuffer_t</a>* <span class="keyword">const</span> pxTraceMultiCoreEventBuffer, <span class="keywordtype">void</span>* pvData, uint32_t uiSize, int32_t* piBytesWritten);</div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span> </div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span><span class="preprocessor">#else</span></div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span> </div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"><a class="line" href="group__trace__multi__core__event__buffer__apis.html#gadb329fba83672d7274b724cc4222206a">  119</a></span><span class="preprocessor">#define xTraceMultiCoreEventBufferAlloc(pxTraceMultiCoreEventBuffer, uiSize, ppvData) xTraceEventBufferAlloc((pxTraceMultiCoreEventBuffer)-&gt;xEventBuffer[TRC_CFG_GET_CURRENT_CORE()], uiSize, ppvData)</span></div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno">  120</span> </div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"><a class="line" href="group__trace__multi__core__event__buffer__apis.html#gaf5ee31252fbbf0c4fcd9574d2de2eaaf">  129</a></span><span class="preprocessor">#define xTraceMultiCoreEventBufferAllocCommit(pxTraceMultiCoreEventBuffer, pvData, uiSize, piBytesWritten) xTraceEventBufferAllocCommit((pxTraceMultiCoreEventBuffer)-&gt;xEventBuffer[TRC_CFG_GET_CURRENT_CORE()], pvData, uiSize, piBytesWritten)</span></div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno">  130</span> </div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno"><a class="line" href="group__trace__multi__core__event__buffer__apis.html#gabd1c68a3c443385a498221cd82ec20a5">  147</a></span><span class="preprocessor">#define xTraceMultiCoreEventBufferPush(pxTraceMultiCoreEventBuffer, pvData, uiSize, piBytesWritten) xTraceEventBufferPush((pxTraceMultiCoreEventBuffer)-&gt;xEventBuffer[TRC_CFG_GET_CURRENT_CORE()], pvData, uiSize, piBytesWritten)</span></div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno">  148</span> </div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno">  149</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno">  150</span> </div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno">  165</span>traceResult <a class="code hl_function" href="group__trace__multi__core__event__buffer__apis.html#ga9f22ae0699ab9175723fd4187c36ba10">xTraceMultiCoreEventBufferTransferAll</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structTraceMultiCoreEventBuffer.html">TraceMultiCoreEventBuffer_t</a>* <span class="keyword">const</span> pxTraceMultiCoreEventBuffer, int32_t* piBytesWritten);</div>
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno">  166</span> </div>
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno">  179</span>traceResult <a class="code hl_function" href="group__trace__multi__core__event__buffer__apis.html#ga75036ca2ae15eb9f91301417117bff68">xTraceMultiCoreEventBufferTransferChunk</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structTraceMultiCoreEventBuffer.html">TraceMultiCoreEventBuffer_t</a>* <span class="keyword">const</span> pxTraceMultiCoreEventBuffer, uint32_t uiChunkSize, int32_t* piBytesWritten);</div>
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno">  180</span> </div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno">  189</span>traceResult <a class="code hl_function" href="group__trace__multi__core__event__buffer__apis.html#ga119a059b35f8d3f71f26f3b794615b58">xTraceMultiCoreEventBufferClear</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structTraceMultiCoreEventBuffer.html">TraceMultiCoreEventBuffer_t</a>* <span class="keyword">const</span> pxTraceMultiCoreEventBuffer);</div>
<div class="line"><a id="l00190" name="l00190"></a><span class="lineno">  190</span> </div>
<div class="line"><a id="l00193" name="l00193"></a><span class="lineno">  193</span><span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a id="l00194" name="l00194"></a><span class="lineno">  194</span>}</div>
<div class="line"><a id="l00195" name="l00195"></a><span class="lineno">  195</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00196" name="l00196"></a><span class="lineno">  196</span> </div>
<div class="line"><a id="l00197" name="l00197"></a><span class="lineno">  197</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00198" name="l00198"></a><span class="lineno">  198</span> </div>
<div class="line"><a id="l00199" name="l00199"></a><span class="lineno">  199</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="agroup__trace__multi__core__event__buffer__apis_html_ga119a059b35f8d3f71f26f3b794615b58"><div class="ttname"><a href="group__trace__multi__core__event__buffer__apis.html#ga119a059b35f8d3f71f26f3b794615b58">xTraceMultiCoreEventBufferClear</a></div><div class="ttdeci">traceResult xTraceMultiCoreEventBufferClear(const TraceMultiCoreEventBuffer_t *const pxTraceMultiCoreEventBuffer)</div><div class="ttdoc">Clears all data from event buffer.</div><div class="ttdef"><b>Definition:</b> trcMultiCoreEventBuffer.c:144</div></div>
<div class="ttc" id="agroup__trace__multi__core__event__buffer__apis_html_ga75036ca2ae15eb9f91301417117bff68"><div class="ttname"><a href="group__trace__multi__core__event__buffer__apis.html#ga75036ca2ae15eb9f91301417117bff68">xTraceMultiCoreEventBufferTransferChunk</a></div><div class="ttdeci">traceResult xTraceMultiCoreEventBufferTransferChunk(const TraceMultiCoreEventBuffer_t *const pxTraceMultiCoreEventBuffer, uint32_t uiChunkSize, int32_t *piBytesWritten)</div><div class="ttdoc">Transfer multi-core trace event buffer data through streamport.</div><div class="ttdef"><b>Definition:</b> trcMultiCoreEventBuffer.c:117</div></div>
<div class="ttc" id="agroup__trace__multi__core__event__buffer__apis_html_ga9f22ae0699ab9175723fd4187c36ba10"><div class="ttname"><a href="group__trace__multi__core__event__buffer__apis.html#ga9f22ae0699ab9175723fd4187c36ba10">xTraceMultiCoreEventBufferTransferAll</a></div><div class="ttdeci">traceResult xTraceMultiCoreEventBufferTransferAll(const TraceMultiCoreEventBuffer_t *const pxTraceMultiCoreEventBuffer, int32_t *piBytesWritten)</div><div class="ttdoc">Transfer multi-core trace event buffer data through streamport.</div><div class="ttdef"><b>Definition:</b> trcMultiCoreEventBuffer.c:89</div></div>
<div class="ttc" id="agroup__trace__multi__core__event__buffer__apis_html_gabd1c68a3c443385a498221cd82ec20a5"><div class="ttname"><a href="group__trace__multi__core__event__buffer__apis.html#gabd1c68a3c443385a498221cd82ec20a5">xTraceMultiCoreEventBufferPush</a></div><div class="ttdeci">#define xTraceMultiCoreEventBufferPush(pxTraceMultiCoreEventBuffer, pvData, uiSize, piBytesWritten)</div><div class="ttdoc">Pushes data into multi-core trace event buffer.</div><div class="ttdef"><b>Definition:</b> trcMultiCoreEventBuffer.h:147</div></div>
<div class="ttc" id="agroup__trace__multi__core__event__buffer__apis_html_gadb329fba83672d7274b724cc4222206a"><div class="ttname"><a href="group__trace__multi__core__event__buffer__apis.html#gadb329fba83672d7274b724cc4222206a">xTraceMultiCoreEventBufferAlloc</a></div><div class="ttdeci">#define xTraceMultiCoreEventBufferAlloc(pxTraceMultiCoreEventBuffer, uiSize, ppvData)</div><div class="ttdoc">Allocates a data slot directly from the event buffer.</div><div class="ttdef"><b>Definition:</b> trcMultiCoreEventBuffer.h:119</div></div>
<div class="ttc" id="agroup__trace__multi__core__event__buffer__apis_html_gaf23fd9ffec1156975504070f60c3e55f"><div class="ttname"><a href="group__trace__multi__core__event__buffer__apis.html#gaf23fd9ffec1156975504070f60c3e55f">TraceMultiCoreEventBuffer_t</a></div><div class="ttdeci">struct TraceMultiCoreEventBuffer TraceMultiCoreEventBuffer_t</div><div class="ttdoc">Trace Multi-Core Event Buffer Structure.</div></div>
<div class="ttc" id="agroup__trace__multi__core__event__buffer__apis_html_gaf5ee31252fbbf0c4fcd9574d2de2eaaf"><div class="ttname"><a href="group__trace__multi__core__event__buffer__apis.html#gaf5ee31252fbbf0c4fcd9574d2de2eaaf">xTraceMultiCoreEventBufferAllocCommit</a></div><div class="ttdeci">#define xTraceMultiCoreEventBufferAllocCommit(pxTraceMultiCoreEventBuffer, pvData, uiSize, piBytesWritten)</div><div class="ttdoc">Commits the last allocated block to the event buffer.</div><div class="ttdef"><b>Definition:</b> trcMultiCoreEventBuffer.h:129</div></div>
<div class="ttc" id="astructTraceEventBuffer_html"><div class="ttname"><a href="structTraceEventBuffer.html">TraceEventBuffer</a></div><div class="ttdoc">Trace Event Buffer Structure.</div><div class="ttdef"><b>Definition:</b> trcEventBuffer.h:48</div></div>
<div class="ttc" id="astructTraceMultiCoreEventBuffer_html"><div class="ttname"><a href="structTraceMultiCoreEventBuffer.html">TraceMultiCoreEventBuffer</a></div><div class="ttdoc">Trace Multi-Core Event Buffer Structure.</div><div class="ttdef"><b>Definition:</b> trcMultiCoreEventBuffer.h:36</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="trcMultiCoreEventBuffer_8h.html">trcMultiCoreEventBuffer.h</a></li>
    <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6 </li>
  </ul>
</div>
</body>
</html>
